home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / gnu / emacs / emacs1857 / bin_d2.zoo / lisp / cl-indent.el < prev    next >
Lisp/Scheme  |  1991-12-02  |  19KB  |  462 lines
  1. ;; Lisp mode, and its idiosyncratic commands.
  2. ;; Copyright (C) 1987 Free Software Foundation, Inc.
  3. ;; Written by Richard Mlynarik July 1987
  4.  
  5. ;; This file is part of GNU Emacs.
  6.  
  7. ;; GNU Emacs is free software; you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation; either version 1, or (at your option)
  10. ;; any later version.
  11.  
  12. ;; GNU Emacs is distributed in the hope that it will be useful,
  13. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. ;; GNU General Public License for more details.
  16.  
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  19. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  20.  
  21. ;;>> TODO
  22. ;; :foo
  23. ;;   bar
  24. ;; :baz
  25. ;;   zap
  26. ;; &key (like &body)??
  27.  
  28. ;; &rest 1 in lambda-lists doesn't work
  29. ;;  -- really want (foo bar
  30. ;;                  baz)
  31. ;;     not (foo bar
  32. ;;              baz)
  33. ;;  Need something better than &rest for such cases
  34.  
  35.  
  36. ;;; Hairy lisp indentation.
  37.  
  38. (defvar lisp-indent-maximum-backtracking 3
  39.   "*Maximum depth to backtrack out from a sublist for structured indentation.
  40. If this variable is  0, no backtracking will occur and forms such as  flet
  41. may not be correctly indented.")
  42.  
  43. (defvar lisp-tag-indentation 1
  44.   "*Indentation of tags relative to containing list.
  45. This variable is used by the function  lisp-indent-tagbody.")
  46.  
  47. (defvar lisp-tag-body-indentation 3
  48.   "*Indentation of non-tagged lines relative to containing list.
  49. This variable is used by the function  lisp-indent-tagbody  to indent normal
  50. lines (lines without tags).
  51. The indentation is relative to the indentation of the parenthesis enclosing
  52. he special form.  If the value is  t, the body of tags will be indented
  53. as a block at the same indentation as the first s-expression following
  54. the tag.  In this case, any forms before the first tag are indented
  55. by lisp-body-indent.")
  56.  
  57.  
  58. (defun common-lisp-indent-hook (indent-point state)
  59.   (let ((normal-indent (current-column)))
  60.     ;; Walk up list levels until we see something
  61.     ;;  which does special things with subforms.
  62.     (let ((depth 0)
  63.           ;; Path describes the position of point in terms of
  64.           ;;  list-structure with respect to contining lists.
  65.           ;; `foo' has a path of (0 4 1) in `((a b c (d foo) f) g)'
  66.           (path ())
  67.           ;; set non-nil when somebody works out the indentation to use
  68.           calculated
  69.           (last-point indent-point)
  70.           ;; the position of the open-paren of the innermost containing list
  71.           (containing-form-start (elt state 1))
  72.           ;; the column of the above
  73.           sexp-column)
  74.       ;; Move to start of innermost containing list
  75.       (goto-char containing-form-start)
  76.       (setq sexp-column (current-column))
  77.       ;; Look over successively less-deep containing forms
  78.       (while (and (not calculated)
  79.                   (< depth lisp-indent-maximum-backtracking))
  80.         (let ((containing-sexp (point)))
  81.           (forward-char 1)
  82.           (parse-partial-sexp (point) indent-point 1 t)
  83.           ;; Move to the car of the relevant containing form
  84.           (let (tem function method)
  85.             (if (not (looking-at "\\sw\\|\\s_"))
  86.                 ;; This form doesn't seem to start with a symbol
  87.                 (setq function nil method nil)
  88.               (setq tem (point))
  89.               (forward-sexp 1)
  90.               (setq function (downcase (buffer-substring tem (point))))
  91.               (goto-char tem)
  92.               (setq tem (intern-soft function)
  93.                     method (get tem 'common-lisp-indent-hook))
  94.               (cond ((and (null method)
  95.                           (string-match ":[^:]+" function))
  96.                      ;; The pleblisp package feature
  97.                      (setq function (substring function
  98.                                                (1+ (match-beginning 0)))
  99.                            method (get (intern-soft function)
  100.                                        'common-lisp-indent-hook)))
  101.                     ((and (null method))
  102.                      ;; backwards compatibility
  103.                      (setq method (get tem 'lisp-indent-hook)))))
  104.             (let ((n 0))
  105.               ;; How far into the containing form is the current form?
  106.               (if (< (point) indent-point)
  107.                   (while (condition-case ()
  108.                              (progn
  109.                                (forward-sexp 1)
  110.                                (if (>= (point) indent-point)
  111.                                    nil
  112.                                  (parse-partial-sexp (point)
  113.                                                      indent-point 1 t)
  114.                                  (setq n (1+ n))
  115.                                  t))
  116.                            (error nil))))
  117.               (setq path (cons n path)))
  118.  
  119.             ;; backwards compatibility.
  120.             (cond ((null function))
  121.                   ((null method)
  122.                    (if (null (cdr path))
  123.                        ;; (package prefix was stripped off above)
  124.                        (setq method (cond ((string-match "\\`def"
  125.                                                          function)
  126.                                            '(4 (&whole 4 &rest 1) &body))
  127.                                           ((string-match "\\`\\(with\\|do\\)-"
  128.                                                          function)
  129.                                            '(4 &body))))))
  130.                   ;; backwards compatibility.  Bletch.
  131.                   ((eq method 'defun)
  132.                    (setq method '(4 (&whole 4 &rest 1) &body))))
  133.  
  134.             (cond ((and (memq (char-after (1- containing-sexp)) '(?\' ?\`))
  135.                         (not (eql (char-after (- containing-sexp 2)) ?\#)))
  136.                    ;; No indentation for "'(...)" elements
  137.                    (setq calculated (1+ sexp-column)))
  138.                   ((eql (char-after (1- containing-sexp)) ?\#)
  139.                    ;; "#(...)"
  140.                    (setq calculated (1+ sexp-column)))
  141.                   ((null method))
  142.                   ((integerp method)
  143.                    ;; convenient top-level hack.
  144.                    ;;  (also compatible with lisp-indent-hook)
  145.                    ;; The number specifies how many `distinguished'
  146.                    ;;  forms there are before the body starts
  147.                    ;; Equivalent to (4 4 ... &body)
  148.                    (setq calculated (cond ((cdr path)
  149.                                            normal-indent)
  150.                                           ((<= (car path) method)
  151.                                            ;; `distinguished' form
  152.                                            (list (+ sexp-column 4)
  153.                                                  containing-form-start))
  154.                                           ((= (car path) (1+ method))
  155.                                            ;; first body form.
  156.                                            (+ sexp-column lisp-body-indent))
  157.                                           (t
  158.                                            ;; other body form
  159.                                            normal-indent))))
  160.                   ((symbolp method)
  161.                    (setq calculated (funcall method
  162.                                              path state indent-point
  163.                                              sexp-column normal-indent)))
  164.                   (t
  165.                    (setq calculated (lisp-indent-259
  166.                                       method path state indent-point
  167.                                       sexp-column normal-indent)))))
  168.           (goto-char containing-sexp)
  169.           (setq last-point containing-sexp)
  170.           (if (not calculated)
  171.               (condition-case ()
  172.                    (progn (backward-up-list 1)
  173.                           (setq depth (1+ depth)))
  174.                 (error (setq depth lisp-indent-maximum-backtracking))))))
  175.       calculated)))
  176.  
  177.  
  178. (defun lisp-indent-report-bad-format (m)
  179.   (error "%s has a badly-formed %s property: %s"
  180.          ;; Love them